home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / adlg17b.zip / ADLOGO.DOC < prev    next >
Text File  |  1992-02-13  |  18KB  |  434 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.            ▒▒▒▒▒▒              ▒▒▄
  27.          ▒▒█▀▀▀▀▀▒▒▄           ▒▒█
  28.          ▒▒█     ▒▒█       ▒▄  ▒▒█
  29.          ▒▒█     ▒▒█       ▒█  ▒▒█
  30.          ▒▒█     ▒▒█       ▒█  ▒▒█
  31.          ▒▒▒▒▒▒▒▒▒▒█ ▒▒▒▒▒▒▒█  ▒▒█        ▒▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒▄
  32.          ▒▒██████▒▒█ ▒█▀▀▀▀▒█  ▒▒█        ▒█▀▀▀▀▒█ ▒█▀▀▀▀▒█ ▒█▀▀▀▀▒█
  33.          ▒▒█     ▒▒█ ▒▒▒▒▒▒▒█  ▒▒▒▒▒▒▒▒▒▄ ▒▒▒▒▒▒▒█ ▒▒▒▒▒▒▒█ ▒▒▒▒▒▒▒█
  34.           ▀▀      ▀▀  ▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀  ▀▀▀▀▀▒█  ▀▀▀▀▀▀▀
  35.                                                          ▒█
  36.                                                     ▒▒▒▒▒▒█
  37.                                                      ▀▀▀▀▀▀
  38.  
  39.  
  40.  AdLogo v1.4ßeta               Page 1
  41.  
  42.                            AdLogo v1.4ßeta
  43.                                  by
  44.                           Michael J. Cambra
  45.          Licensed to TMC SoftWare/OTS Software Development Corp.
  46.  
  47.  
  48.     WHAT IS IT??
  49.     ------------
  50.  
  51.     AdLogo is a PCBoard utility that will add your BBS's ZIP 'Logo'
  52.     (ZipComment) to those files that are located on your CD-ROM.
  53.  
  54.     You say that you don't have a CD-ROM? No problem. After a period
  55.     of time (Months, Years) you have problably changed your ZipComment
  56.     at least a few times and only those files that have been received
  57.     since the last time your have changed your logo, will contain it.
  58.  
  59.     AdLogo will also change those outdated ZipComments (from herein
  60.     called 'Logo') to your most recent 'Logo'.
  61.  
  62.  
  63.     WHAT OTHER PURPOSE DOES IT HAVE?
  64.     --------------------------------
  65.  
  66.     Great question!  Let's say you have 2000 files on your board that are
  67.     downloadable files and each of those files contains your board's
  68.     'Logo'. If the average size of each 'Logo' that is contained in those
  69.     files is 2000 bytes (or 2K). We then take 2000 times the size of the
  70.     'Logo' and that comes out to be a total of 4meg!!  4meg of space
  71.     wasted JUST by those files containing your board's 'Logo'.  Plus, this
  72.     4meg figure is increased EVERYTIME a new file is placed on your system!
  73.  
  74.     Well, with AdLogo, you can gain back that wasted 4meg+ and STILL have
  75.     every ZIP file that is downloaded by your users contain your board's
  76.     'Logo' by simply removing the current 'Logo' from all of those files.
  77.     (This may sound like a big job, however, it isn't. There are shareware
  78.     utils that will make this job painless!)
  79.  
  80.     HOW?
  81.     ---
  82.  
  83.     AdLogo will add your board's 'Logo' to each .ZIP file that a user
  84.     chooses to download RIGHT before the transfer is started.
  85.  
  86.  AdLogo v1.4ßeta                   Page 2
  87.  
  88.    OPERATION
  89.    ---------
  90.  
  91.    AdLogo is placed is all of your board's PCBS?.BAT files one line before
  92.    the command line for the transfer protocol. When PCBoard Shell's out
  93.    to the batch file, AdLogo will do the following:
  94.  
  95.      1) First it will determind if the transfer is a SIGNLE file download
  96.         or a BATCH downlaod.
  97.  
  98.      2) It will then check each file and determine if it/they are located
  99.         on a MATCHED CD-ROM (or MATCH HARD DRIVE, herein called CD-ROM)
  100.  
  101.      3) If any of the files are on the CD-ROM, it will then copy the file
  102.         over to a TEMP directory, and add your board's comment to each file.
  103.  
  104.    If the file(s) is/are not a .ZIP, or not on a MATCHED CD-ROM, the file(s)
  105.    are not touched in anyway.
  106.  
  107.    SYNTAX
  108.    ------
  109.  
  110.    AdLogo <CFGFILE> %NODE% %3
  111.  
  112.       CFGFILE  --  is the full path and filename of the configuration
  113.                    file that you are using. This .CFG file can be named
  114.                    valid DOS filename (ie: C:\PCB\ADLOGO.CFG)
  115.                    (See end of docs for format of .CFG file)
  116.  
  117.       %NODE%   --  this is the enviroment NODE setting. You probably
  118.                    already have this setting defined in each of your
  119.                    board's BOARD.BAT file. However, if you do not, simply
  120.                    add a line somewhere before the PCB145.EXE command like
  121.                    this: SET NODE=n (where 'n' is the number for this node's
  122.                    nodes BOARD.BAT file-Single Node Systems, use 1)
  123.  
  124.       %3      --   Place %3 as the last argument on the AdLogo command
  125.                    line. This is the filename, or text file of the paths
  126.                    of the filenames in a batch transfer, that PCBoard
  127.                    passes to the PCBS?.BAT files
  128.  
  129.    An example of the AdLogo command line would be like this:
  130.  
  131.    AdLogo C:\PCB\ADLOGO.CFG %NODE% %3
  132.  
  133.  
  134.  
  135.  AdLogo v1.4ßeta                   Page 3
  136.  
  137.  
  138.    INSTALLATION
  139.    ------------
  140.       Installing AdLogo into your system is easy and should take no more
  141.       than 10 minutes!
  142.  
  143.       First, decide what drive you are going to place your TEMP directory
  144.       on. (HINT: Choose your FASTEST hard drive!). Then choose the name
  145.       of your TEMP directory. You call this directory ANYTHING you wish,
  146.       as long as it is a valid DOS directory name. Now create the TEMP
  147.       directory on the drive your chose.
  148.  
  149.                    NOTE: If you are running a Multi-Node system, you
  150.                          MUST create different TEMP directory for each
  151.                          Node! (ie  N:\TEMP1, N:\TEMP2, etc...)
  152.                          If you are running a SINGLE Node system, you
  153.                          MUST create the directory with the number 1
  154.                          as the last character! (ie: N:\TEMP1)
  155.  
  156.      Second, copy AdLOGO.EXE to a directory that is defined in your DOS
  157.      PATH statement. (HINT: For FASTEST execution, try to place AdLogo.exe
  158.      in one of the FIRST directories listed in your PATH statement.)
  159.  
  160.      Third, edit each of your PCBSZ.BAT files. If you have added other
  161.      protocols to your system, you edit these as well. However, we will
  162.      use PCBSZ.BAT (Which is the ZModem download batch file for the
  163.      examples).
  164.  
  165.          The first thing we you will need to do is place your AdLogo
  166.          command line right before the DSZ command line.
  167.          Here is an example of what we are doing:
  168.  
  169.          PCBSZ.BAT before AdLogo:
  170.          @echo off
  171.          if exist pcberr.fil del pcberr.fil
  172.          if exist pcbdsz.lgo del pcbdsz.log
  173.          DSZ port %1 handshake both pB4096 estimate 0 %5 z sz -r %3
  174.  
  175.          PCBSZ.BAT After adding AdLogo
  176.          @echo off
  177.          if exist pcberr.fil del pcberr.fil
  178.          if exist pcbdsz.log del pcbdsz.log
  179.          AdLogo C:\PCB\ADLOGO.CFG %NODE% %3
  180.          DSZ port %1 etc....
  181.  
  182.  AdLogo v1.4ßeta                   Page 4
  183.  
  184.          Now we must change the %3 in the DSZ command line to read
  185.          '@%DRIVE%ADLOGO.LST' (without the quotes).
  186.  
  187. DSZ port %1 handshake BOTH pB4096 estimate 0 %5 z sz -r @%DRIVE%ADLOGO.LST
  188.  
  189.           NOTE: In each of your node's BOARD.BAT file, you must create
  190.           a SET DRIVE=n enviroment setting where 'n' is the DRIVE for that
  191.           node. (ie: SET DRIVE=C:)
  192.  
  193.          (Don't worry if this line happens to go past 80 characters.)
  194.  
  195.          Why in the world are we changing that for, you ask?!?! I will
  196.          explain AdLogo workings in a little more detail after the
  197.          Installation!
  198.  
  199.          Now, we need to add three (3) lines after the DSZ command line.
  200.          First, add these two lines:
  201.  
  202.          if exist pcbdsz.lst del pcbdsz.lst
  203.          if exist adlogo.lst del adlogo.lst
  204.  
  205.          And last, we have to add one more DEL command to the batch file.
  206.  
  207.          if exist n:\temp%NODE%\*.zip del n:\temp%NODE%\*.zip
  208.  
  209.          This will remove any files that were moved over to the TEMP
  210.          directory by AdLogo.
  211.  
  212.       Your new PCBSZ.BAT file should look like this..
  213.  
  214.       @echo off
  215.       if exist pcberr.fil del pcberr.fil
  216.       if exist pcbdsz.log del pcbdsz.log
  217.       AdLogo C:\PCB\ADLOGO.CFG %NODE% %3
  218.       DSZ port %1 .....   @ADLOGO.LST
  219.       if exist pcbdsz.lst del pcbdsz.lst
  220.       if exist adlogo.lst del adlogo.lst
  221.       if exist n:\temp%NODE%\*.zip del n:\temp%NODE%\*.zip
  222.  
  223.       That's it!! Save your new PCBSZ.BAT file it's complete! If you have
  224.       added other external protocols to your PCBoard system, you can follow
  225.       the same instructions above to add AdLogo and it's workings to all of
  226.       your external protocol's batch files. Just make sure that the AdLogo
  227.       command line is somewhere BEFORE the command line for the external
  228.       protocol and that the last three lines are added at the end.
  229.  
  230.       Ooops, one more thing, PKZip.EXE must be in one of your DOS'S PATHS!
  231.  
  232.  AdLogo v1.4ßeta                   Page 5
  233.  
  234.  
  235.     HOW IT WORKS
  236.     ------------
  237.  
  238.     AdLogo first determines if the transfer is a SINGLE file transfer or
  239.     a BATCH transfer.
  240.  
  241.     If it is a SIGNLE file transfer, AdLogo will then read the %3 parameter
  242.     that is passed to it and determine if that file is located on one of the
  243.     Drives that is pointed to by <CD-ROM>. If the file IS on a MATCHED drive,
  244.     AdLogo will copy the file over to the TEMP directory, pointed to by
  245.     <TEMPDIR> AND %NODE%, and then will execute PKZip and add your board's
  246.     'Logo' to that file. AdLogo will then create a file called ADLOGO.LST
  247.     in the current PCB Node's directory, and write the new path of the file
  248.     that contians your board's 'Logo'.  AdLogo will then exit and the
  249.     external protocol will then read ADLOGO.LST and begin transfer of that
  250.     file.
  251.  
  252.     If AdLogo detects that a BATCH transfer is about to begin, AdLogo will
  253.     read each line of PCBDSZ.LST (this is the file that is created by PCBoard
  254.     for batch transfers). As each line is read, AdLogo will do the same as
  255.     it does for the SINGLE file transfer.
  256.  
  257.     If, during either a SINGLE file or Batch transfer, the file, or any of
  258.     the files, selected are NOT a .ZIP file, or NOT on a MATCHED drive,
  259.     AdLogo will simply copy the path of the file to AdLogo.lst.  This is
  260.     why we changed the %3 in the DSZ command line to @ADLOGO.LST.
  261.     AdLogo will create ADLOGO.LST EVERYTIME it is executed.
  262.  
  263.    PROGRAM COMPATABLILTY
  264.    ---------------------
  265.  
  266.    There are some DOORS for PCBoard that have the option of using PCBoard's
  267.    external protocol batch files to send and receive information. One of
  268.    these DOORS is the ever popular Qwik Mail Door from SparkWare. With the
  269.    addition of AdLogo in these selected batch files that QMail may also use,
  270.    you are probably wondering if AdLogo is compatable with these 'Other
  271.    Programs'. The answer to this question is YES!
  272.  
  273.    For example, a user opens a mail door and wishes to download a mail packet.
  274.    The door scans for new mail, prepairs it, archives it, and then calls on
  275.    the PCBSZ.BAT (Zmodem, for this example) to start the file transfer.
  276.    Even though AdLogo works with ZIP files, AdLogo will detect that the file
  277.    to be transfered is a mail packet, and will do nothing to that file. It
  278.    will leave the file in place, and simply pass the parameter of the path
  279.    of the mail packet file to the external protocol.
  280.  
  281.  AdLogo v1.4ßeta               Page 6
  282.  
  283.    LEGAL STUFF
  284.    -----------
  285.  
  286.    As much as we all hate this, I must too add this in just to keep every-
  287.    thing on the up-and-up!
  288.  
  289.    ADLOGO AND ALL OF IT'S ASSOCITATED FILES ARE RELEASED TO THE PUBLIC AS
  290.    SHAREWARE. TMC SOFTWARE RETAINS ALL COPYRIGHTS TO THESE UTILITIES AND
  291.    DOCUMENTATIONS.
  292.  
  293.    ADLOGO MAY BE DISTRIBUTED TO THE PUBLIC AS LONG AS THE ARCHIVE FILE
  294.    THAT ADLOGO.EXE IS CONTAINED IN IS ALTERED IN ANYWAY OR FORM. THIS
  295.    MEANS THAT NO FILES MAY BE ADDED TO THIS ARCHIVE WITHOUT PRIOR WRITTEN
  296.    CONSENT FROM TMC SOFTWARE DEVELOPMENT. THE EXCEPTION TO THIS IS ONLY
  297.    TO THE ZIPCOMMENT THAT THIS ARCHIVE CONTIANS. NO BBS ADS IN THE FORM
  298.    OF TEXT FILES, EXECUTABLE .EXE OR .COM FILES, OR IN ANY OTHER FORM ARE
  299.    PERMITTED TO BE ADDED.
  300.  
  301.    I, MICHAEL J. CAMBRA, TMC SOFTWARE DEVELOPMENT, OTS DEVELOPMENT CORP, ARE
  302.    IN NO WAY LIABLE FOR ANY DAMAGES, EITHER IN THE FORM OF HARDWARE OR
  303.    SOFTWARE, TIME LOST, OR MOENY(IES) LOST, DUE TO THE OPERATION OF
  304.    ADLOGO.EXE AND ITS SUPPLIMENTERY UTILITIES.
  305.  
  306.    Adlogo has been put through a number of tests. Many efforts has been
  307.    placed into the code to prevent any kind of accidental damaging occuring.
  308.    However, before installing this software, as it is a good practice
  309.    before installing ANY new software, to make a backup of your important
  310.    system files.
  311.  
  312.  AdLogo v1.4ßeta                   Page 7
  313.  
  314.  
  315.    REGISTRATION
  316.    ------------
  317.  
  318.     AdLogo is SHARWARE.  You may try this program out for a period of no
  319.     more than 30 days from the date of installation. After this 30 period
  320.     has expired, you are required to either register this software, or
  321.     remove the software from your system and discontinue its use.
  322.  
  323.     The Registration fee for AdLogo v1.4ßeta is currently $15.00 (US).
  324.     When the first official version is released, the registration fee
  325.     will incress to $25.00 (US).
  326.  
  327.     Upon registering AdLogo, you will receive the following:
  328.  
  329.         -- AdLogo ENHANCED version
  330.         -- Personal Serial Number
  331.         -- Free future updates.
  332.         -- Advanced noticed on future updates (Two weeks - Nonßeta versions)
  333.         -- Complete set of batch files to add to PCBoard for AdLogo to
  334.            run under XModem, XModem(CRC), 1k-XModem, YModem, & Ymodem/G
  335.         -- Free One Year access to The "Port of Call" BBS
  336.            & The 'Port of Call-East' BBS for instant support and the
  337.            lastest version of AdLogo
  338.         -- Voice Support
  339.  
  340.     To register your copy of AdLogo, print out REGISTER.FRM, complete it,
  341.     include either a Check or Money Order made out to Michael Cambra, and
  342.     mail it to:
  343.  
  344.                The 'Port of Call-East'
  345.            c/o Michael Cambra
  346.                20 Nonquit Ln.
  347.                Tiverton, RI. 02878-4814
  348.  
  349.                ATTN: TMC SOFTWARE
  350.  
  351.  AdLogo v1.4ßeta               Page 8
  352.  
  353.     SUPPORT
  354.     -------
  355.  
  356.       For the lastest updates to support, you can call the following boards:
  357.  
  358.                Indiana -  The "Port of Call" BBS
  359.                           (219)-763-2091 <CompuCom>
  360.                           (219)-763-1940 <HST> - Registered Users Only
  361.                           Join Conference # 69
  362.                           Address Messages to MIKE CAMBRA
  363.  
  364.           Rhode Island -  The 'Port of Call-East'
  365.                           (401)-624-6541 <v.32bis>
  366.                           Address Messages to SYSOP
  367.                           Join Conference #216
  368.                           Address Messages to SYSOP or MIKE CAMBRA
  369.  
  370.       AdLogo will be released as ADLG*.ZIP
  371.       (*= Version number, release number, & B for Beta versions)
  372.  
  373.     Or, you can contact me by E-Mail via the following Networks:
  374.  
  375.         NorthAmericaNet (NANET)    MIKE CAMBRA
  376.         New England Net (NENET)    MIKE CMABRA
  377.         Medical Net     (MEDINET)  MIKE CAMBRA
  378.  
  379.   AdLogo v1.4ßeta              Page 9
  380.  
  381.     ACKNOWLEDGEMENTS
  382.     ----------------
  383.  
  384.          I wish to thank Brian Cload, Sysop of The "Port of Call" BBS
  385.          for all the help and support he has given me during the ßeta
  386.          testing of AdLogo and putting it thru all the tests and finding
  387.          all those 'Typos' in the docs! Guess that's what happens when
  388.          your looking at the code for 13 hours stright!
  389.  
  390.     TRADEMARKS
  391.     ----------
  392.  
  393.         PCBoard...............................Clark Development Co.
  394.         Qwik Mail Door (QMail)................Sparkware
  395.         PKZip.................................PKWare, Inc.
  396.         North America Net.....................Canada Remotes Systems
  397.         New England Net.......................Mike Labbe/Eagle's Nest Network
  398.         Medical Net...........................Gary Hedberg
  399.         DSZ...................................Omen Tech, Inc.
  400.         HS/Link...............................Sam H. Smith/Tool Shop BBS
  401.         OTS Software Development Corp.........Brian Cload/
  402.                                                    The "Port of Call" BBS
  403.  
  404.  AdLogo v1.4ßeta               Page 10
  405.  
  406.    .CFG FILE
  407.    ---------
  408.  
  409.      The .CFG file for AdLogo is a simple text file made up of a total of
  410.      8 lines.  Any text editor can be used to create/edit this file.
  411.      The format of the file is as follows:
  412.  
  413.           Line 1 - Your Name (32 chars max)
  414.           Line 2 - Serial #  (00000 if UNREGISTERED)
  415.           Line 3 - PassCode  (0000000000 if UNREGISTERED)
  416.           Line 4 - CD-ROM (or Hard Drive) Drive Letters
  417.           Line 5 - TEMP directory
  418.           Line 6 - FULL Path & Filename of ZipComment (BBS LOGO)
  419.           Line 7 - FULL PAth and Filename of Callers Log file
  420.                    (Do NOT Place a node number here if running MultiNode!)
  421.           Line 8 - Y or N  (Y=MultiNode System, N=Single Node)
  422.  
  423.     A Sample .CFG file is included in the archive.  You can simply edit this
  424.     file as needed. However, Line 2 MUST be five (5) 0's (Zeros) and
  425.     Line 3 MUST be ten (10) 0's (zeros) if you have not registered your
  426.     copy of AdLogo.
  427.  
  428.     After editing this file, copy it to the directory the same directory
  429.     where you placed AdLogo.EXE.
  430.  
  431.     REMEMBER, even though AdLogo.exe and AdLogo.CFG (or whatever you
  432.     name your configuartion file), you MUST give the AdLogo commnad line
  433.     the FULL DRIVE:\PATH\FILENAME.EXT of this file!!
  434.